feat(docs): add TypeDoc API reference links for web SDK #1625
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added API reference section and improved formatting.
Added TypeDoc API reference links for web SDK in documentation and made several breaking changes to the AuthSecretKey and WebClient components.
Collaborator
|
Not sure if we do want to have that linked in our Miden Docs, @BrianSeong99 what do you think? |
|
The migration is expected in the coming weeks, maybe we could add it then with the correct link? |
WiktorStarczewski
approved these changes
Jan 14, 2026
Contributor
WiktorStarczewski
left a comment
WiktorStarczewski
left a comment
There was a problem hiding this comment.
LGTM, small comment
README.md
Outdated
|
|
||
| - `miden-client` library, which can be used by other project to programmatically interact with the Miden rollup. You can find more information about the library in the [Rust client Library](./crates/rust-client/README.md) section. | ||
| - `miden-client-cli`, which is a wrapper around the library exposing its functionality via a simple command-line interface (CLI). You can find more information about the CLI in the [Miden client CLI](./bin/miden-cli/README.md) section. | ||
| - `@demox-labs/miden-sdk` (web client), which is a browser-focused SDK for interacting with the Miden rollup from web applications. You can find more information about the web client in the [Web Client README](./crates/web-client/README.md) section. |
Contributor
There was a problem hiding this comment.
We should change that to @miden-sdk/miden-sdk
Collaborator
I think it's fine to add it for now. We will amend the docs later on anyways. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1356
Adds TypeDoc API reference links for the web SDK to improve documentation discoverability.
Updated main README to include web-client component and added API Reference section in Docusaurus web-client index page.